home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / text.n < prev    next >
Text File  |  1994-09-20  |  39KB  |  998 lines
  1. '\"
  2. '\" Copyright (c) 1992 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/text.n,v 1.12 93/10/23 16:30:35 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS text tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. text \- Create and manipulate text widgets
  210. .SH SYNOPSIS
  211. \fBtext\fI \fIpathName \fR?\fIoptions\fR?
  212. .SH "STANDARD OPTIONS"
  213. .LP
  214. .nf
  215. .ta 4c 8c 12c
  216. \fBbackground\fR    \fBforeground\fR    \fBinsertWidth\fR    \fBselectBorderWidth\fR
  217. \fBborderWidth\fR    \fBinsertBackground\fR    \fBpadX\fR    \fBselectForeground\fR
  218. \fBcursor\fR    \fBinsertBorderWidth\fR    \fBpadY\fR    \fBsetGrid\fR
  219. \fBexportSelection\fR    \fBinsertOffTime\fR    \fBrelief\fR    \fByScrollCommand\fR
  220. \fBfont\fR    \fBinsertOnTime\fR    \fBselectBackground\fR
  221. .fi
  222. .LP
  223. See the ``options'' manual entry for details on the standard options.
  224. .SH "WIDGET-SPECIFIC OPTIONS"
  225. .LP
  226. .nf
  227. Name:    \fBheight\fR
  228. Class:    \fBHeight\fR
  229. Command-Line Switch:    \fB\-height\fR
  230. .fi
  231. .IP
  232. Specifies the desired height for the window, in units of characters.
  233. Must be at least one.
  234. .LP
  235. .nf
  236. Name:    \fBstate\fR
  237. Class:    \fBState\fR
  238. Command-Line Switch:    \fB\-state\fR
  239. .fi
  240. .IP
  241. Specifies one of two states for the text:  \fBnormal\fR or \fBdisabled\fR.
  242. If the text is disabled then characters may not be inserted or deleted
  243. and no insertion cursor will be displayed, even if the input focus is
  244. in the widget.
  245. .LP
  246. .nf
  247. Name:    \fBwidth\fR
  248. Class:    \fBWidth\fR
  249. Command-Line Switch:    \fB\-width\fR
  250. .fi
  251. .IP
  252. Specifies the desired width for the window in units of characters.
  253. If the font doesn't have a uniform width then the width of the
  254. character ``0'' is used in translating from character units to
  255. screen units.
  256. .LP
  257. .nf
  258. Name:    \fBwrap\fR
  259. Class:    \fBWrap\fR
  260. Command-Line Switch:    \fB\-wrap\fR
  261. .fi
  262. .IP
  263. Specifies how to handle lines in the text that are too long to be
  264. displayed in a single line of the text's window.
  265. The value must be \fBnone\fR or \fBchar\fR or \fBword\fR.
  266. A wrap mode of \fBnone\fR means that each line of text appears as
  267. exactly one line on the screen;  extra characters that don't fit
  268. on the screen are not displayed.
  269. In the other modes each line of text will be broken up into several
  270. screen lines if necessary to keep all the characters visible.
  271. In \fBchar\fR mode a screen line break may occur after any character;
  272. in \fBword\fR mode a line break will only be made at word boundaries.
  273. .BE
  274.  
  275. .SH DESCRIPTION
  276. .PP
  277. The \fBtext\fR command creates a new window (given by the
  278. \fIpathName\fR argument) and makes it into a text widget.
  279. Additional
  280. options, described above, may be specified on the command line
  281. or in the option database
  282. to configure aspects of the text such as its default background color
  283. and relief.  The \fBtext\fR command returns the
  284. path name of the new window.
  285. .PP
  286. A text widget displays one or more lines of text and allows that
  287. text to be edited.
  288. Text widgets support three different kinds of annotations on the
  289. text, called tags, marks, and windows.
  290. Tags allow different portions of the text
  291. to be displayed with different fonts and colors.
  292. In addition, Tcl commands can be associated with tags so
  293. that commands are invoked when particular actions such as keystrokes
  294. and mouse button presses occur in particular ranges of the text.
  295. See TAGS below for more details.
  296. .PP
  297. The second form of annotation consists of marks, which are floating
  298. markers in the text.
  299. Marks are used to keep track of various interesting positions in the
  300. text as it is edited.
  301. See MARKS below for more details.
  302. .PP
  303. The third form of annotation allows arbitrary windows to be displayed
  304. in the text widget.
  305. See WINDOWS below for more details.
  306.  
  307. .SH INDICES
  308. .PP
  309. Many of the widget commands for texts take one or more indices
  310. as arguments.
  311. An index is a string used to indicate a particular place within
  312. a text, such as a place to insert characters or one endpoint of a
  313. range of characters to delete.
  314. Indices have the syntax
  315. .IP
  316. \fIbase modifier modifier modifier ...\fR
  317. .LP
  318. Where \fIbase\fR gives a starting point and the \fImodifier\fRs
  319. adjust the index from the starting point (e.g. move forward or
  320. backward one character).  Every index must contain a \fIbase\fR,
  321. but the \fImodifier\fRs are optional.
  322. .LP
  323. The \fIbase\fR for an index must have one of the following forms:
  324. .TP 12
  325. \fIline\fB.\fIchar\fR
  326. Indicates \fIchar\fR'th character on line \fIline\fR.
  327. Lines are numbered from 1 for consistency with other UNIX programs
  328. that use this numbering scheme.
  329. Within a line, characters are numbered from 0.
  330. .TP 12
  331. \fB@\fIx\fB,\fIy\fR
  332. Indicates the character that covers the pixel whose x and y coordinates
  333. within the text's window are \fIx\fR and \fIy\fR.
  334. .TP 12
  335. \fBend\fR
  336. Indicates the last character in the text, which is always a newline
  337. character.
  338. .TP 12
  339. \fImark\fR
  340. Indicates the character just after the mark whose name is \fImark\fR.
  341. .TP 12
  342. \fItag\fB.first\fR
  343. Indicates the first character in the text that has been tagged with
  344. \fItag\fR.
  345. This form generates an error if no characters are currently tagged
  346. with \fItag\fR.
  347. .TP 12
  348. \fItag\fB.last\fR
  349. Indicates the character just after the last one in the text that has
  350. been tagged with \fItag\fR.
  351. This form generates an error if no characters are currently tagged
  352. with \fItag\fR.
  353. .LP
  354. If modifiers follow the base index, each one of them must have one
  355. of the forms listed below.  Keywords such as \fBchars\fR and \fBwordend\fR
  356. may be abbreviated as long as the abbreviation is unambiguous.
  357. .TP
  358. \fB+ \fIcount\fB chars\fR
  359. Adjust the index forward by \fIcount\fR characters, moving to later
  360. lines in the text if necessary.  If there are fewer than \fIcount\fR
  361. characters in the text after the current index, then set the index
  362. to the last character in the text.
  363. Spaces on either side of \fIcount\fR are optional.
  364. .TP
  365. \fB\- \fIcount\fB chars\fR
  366. Adjust the index backward by \fIcount\fR characters, moving to earlier
  367. lines in the text if necessary.  If there are fewer than \fIcount\fR
  368. characters in the text before the current index, then set the index
  369. to the first character in the text.
  370. Spaces on either side of \fIcount\fR are optional.
  371. .TP
  372. \fB+ \fIcount\fB lines\fR
  373. Adjust the index forward by \fIcount\fR lines, retaining the same
  374. character position within the line.  If there are fewer than \fIcount\fR
  375. lines after the line containing the current index, then set the index
  376. to refer to the same character position on the last line of the text.
  377. Then, if the line is not long enough to contain a character at the indicated
  378. character position, adjust the character position to refer to the last
  379. character of the line (the newline).
  380. Spaces on either side of \fIcount\fR are optional.
  381. .TP
  382. \fB\- \fIcount\fB lines\fR
  383. Adjust the index backward by \fIcount\fR lines, retaining the same
  384. character position within the line.  If there are fewer than \fIcount\fR
  385. lines before the line containing the current index, then set the index
  386. to refer to the same character position on the first line of the text.
  387. Then, if the line is not long enough to contain a character at the indicated
  388. character position, adjust the character position to refer to the last
  389. character of the line (the newline).
  390. Spaces on either side of \fIcount\fR are optional.
  391. .TP
  392. \fBlinestart\fR
  393. Adjust the index to refer to the first character on the line.
  394. .TP
  395. \fBlineend\fR
  396. Adjust the index to refer to the last character on the line (the newline).
  397. .TP
  398. \fBwordstart\fR
  399. Adjust the index to refer to the first character of the word containing
  400. the current index.  A word consists of any number of adjacent characters
  401. that are letters, digits, or underscores, or a single character that
  402. is not one of these.
  403. .TP
  404. \fBwordend\fR
  405. Adjust the index to refer to the character just after the last one of the
  406. word containing the current index.  If the current index refers to the last
  407. character of the text then it is not modified.
  408. .LP
  409. If more than one modifier is present then they are applied in
  410. left-to-right order.  For example, the index ``\fBend \- 1 chars\fR''
  411. refers to the next-to-last character in the text and
  412. ``\fBinsert wordstart \- 1 c\fR'' refers to the character just before
  413. the first one in the word containing the insertion cursor.
  414.  
  415. .SH TAGS
  416. .PP
  417. The first form of annotation in text widgets is a tag.
  418. A tag is a textual string that is associated with some of the characters
  419. in a text.
  420. There may be any number of tags associated with characters in a
  421. text.
  422. Each tag may refer to a single character, a range of characters, or
  423. several ranges of characters.
  424. An individual character may have any number of tags associated with it.
  425. .PP
  426. A priority order is defined among tags, and this order is used in
  427. implementing some of the tag-related functions described below.
  428. When a tag is defined (by associating it with characters or setting
  429. its display options or binding commands to it), it is given
  430. a priority higher than any existing tag.
  431. The priority order of tags may be redefined using the
  432. ``\fIpathName \fBtag raise\fR'' and ``\fIpathName \fBtag lower\fR''
  433. widget commands.
  434. .PP
  435. Tags serve three purposes in text widgets.
  436. First, they control the way information is displayed on the screen.
  437. By default, characters are displayed as determined by the
  438. \fBbackground\fR, \fBfont\fR, and \fBforeground\fR options for the
  439. text widget.
  440. However, display options may be associated with individual tags
  441. using the ``\fIpathName \fBtag configure\fR'' widget command.
  442. If a character has been tagged, then the display options associated
  443. with the tag override the default display style.
  444. The following options are currently supported for tags:
  445. .TP
  446. \fB\-background \fIcolor\fR
  447. \fIColor\fR specifies the background color to use for characters
  448. associated with the tag.
  449. It may have any of the forms accepted by \fBTk_GetColor\fR.
  450. .TP
  451. \fB\-bgstipple \fIbitmap\fR
  452. \fIBitmap\fR specifies a bitmap that is used as a stipple pattern
  453. for the background.
  454. It may have any of the forms accepted by \fBTk_GetBitmap\fR.
  455. If \fIbitmap\fR hasn't been specified, or if it is specified
  456. as an empty string, then a solid fill will be used for the
  457. background.
  458. .TP
  459. \fB\-borderwidth \fIpixels\fR
  460. \fIPixels\fR specifies the width of a 3-D border to draw around
  461. the background.
  462. It may have any of the forms accepted by \fBTk_GetPixels\fR.
  463. This option is used in conjunction with the \fB\-relief\fR
  464. option to give a 3-D appearance to the background for characters;
  465. it is ignored unless the \fB\-background\fR option
  466. has been set for the tag.
  467. .TP
  468. \fB\-fgstipple \fIbitmap\fR
  469. \fIBitmap\fR specifies a bitmap that is used as a stipple pattern
  470. when drawing text and other foreground information such as
  471. underlines.
  472. It may have any of the forms accepted by \fBTk_GetBitmap\fR.
  473. If \fIbitmap\fR hasn't been specified, or if it is specified
  474. as an empty string, then a solid fill will be used.
  475. .TP
  476. \fB\-font \fIfontName\fR
  477. \fIFontName\fR is the name of a font to use for drawing characters.
  478. It may have any of the forms accepted by \fBTk_GetFontStruct\fR.
  479. .TP
  480. \fB\-foreground \fIcolor\fR
  481. \fIColor\fR specifies the color to use when drawing text and other
  482. foreground information such as underlines.
  483. It may have any of the forms accepted by \fBTk_GetColor\fR.
  484. .TP
  485. \fB\-relief \fIrelief\fR
  486. \fIRelief specifies the 3-D relief to use for drawing backgrounds,
  487. in any of the forms accepted by \fBTk_GetRelief\fR.
  488. This option is used in conjunction with the \fB\-borderwidth\fR
  489. option to give a 3-D appearance to the background for characters;
  490. it is ignored unless the \fB\-background\fR option
  491. has been set for the tag.
  492. .TP
  493. \fB\-underline \fIboolean\fR
  494. \fIBoolean\fR specifies whether or not to draw an underline underneath
  495. characters.
  496. It may have any of the forms accepted by \fBTk_GetBoolean\fR.
  497. .PP
  498. If a character has several tags associated with it, and if their
  499. display options conflict, then the options of the highest priority
  500. tag are used.
  501. If a particular display option hasn't been specified for a
  502. particular tag, or if it is specified as an empty string, then
  503. that option will never be used;  the next-highest-priority
  504. tag's option will used instead.
  505. If no tag specifies a particular display optionl, then the default
  506. style for the widget will be used.
  507. .PP
  508. The second purpose for tags is event bindings.
  509. You can associate bindings with a tag in much the same way you can
  510. associate bindings with a widget class:  whenever particular X
  511. events occur on characters with the given tag, a given
  512. Tcl command will be executed.
  513. Tag bindings can be used to give behaviors to ranges of characters;
  514. among other things, this allows hypertext-like
  515. features to be implemented.
  516. For details, see the description of the \fBtag bind\fR widget
  517. command below.
  518. .PP
  519. The third use for tags is in managing the selection.
  520. See THE SELECTION below.
  521.  
  522. .SH MARKS
  523. .PP
  524. The second form of annotation in text widgets is a mark.
  525. Marks are used for remembering particular places in a text.
  526. They are something like tags, in that they have names and
  527. they refer to places in the file, but a mark isn't associated
  528. with particular characters.
  529. Instead, a mark is associated with the gap between two characters.
  530. Only a single position may be associated with a mark at any given
  531. time.
  532. If the characters around a mark are deleted the mark will still
  533. remain;  it will just have new neighbor characters.
  534. In contrast, if the characters containing a tag are deleted then
  535. the tag will no longer have an association with characters in
  536. the file.
  537. Marks may be manipulated with the ``\fIpathName \fBmark\fR'' widget
  538. command, and their current locations may be determined by using the
  539. mark name as an index in widget commands.
  540. .PP
  541. The name space for marks is different from that for tags:  the
  542. same name may be used for both a mark and a tag, but they will refer
  543. to different things.
  544. .PP
  545. Two marks have special significance.
  546. First, the mark \fBinsert\fR is associated with the insertion cursor,
  547. as described under THE INSERTION CURSOR below.
  548. Second, the mark \fBcurrent\fR is associated with the character
  549. closest to the mouse and is adjusted automatically to track the
  550. mouse position and any changes to the text in the widget (one
  551. exception:  \fBcurrent\fR is not updated in response to mouse
  552. motions if a mouse button is down;  the update will be deferred
  553. until all mouse buttons have been released).
  554. Neither of these special marks may be unset.
  555.  
  556. .SH WINDOWS
  557. .PP
  558. The third form of annotation in text widgets is a window.
  559. Window support isn't implemented yet, but when it is it will be
  560. described here.
  561.  
  562. .SH THE SELECTION
  563. .PP
  564. Text widgets support the standard X selection.
  565. Selection support is implemented via tags.
  566. If the \fBexportSelection\fR option for the text widget is true
  567. then the \fBsel\fR tag will be associated with the selection:
  568. .IP [1]
  569. Whenever characters are tagged with \fBsel\fR the text widget
  570. will claim ownership of the selection.
  571. .IP [2]
  572. Attempts to retrieve the
  573. selection will be serviced by the text widget, returning all the
  574. charaters with the \fBsel\fR tag.
  575. .IP [3]
  576. If the selection is claimed away by another application or by another
  577. window within this application, then the \fBsel\fR tag will be removed
  578. from all characters in the text.
  579. .PP
  580. The \fBsel\fR tag is automatically defined when a text widget is
  581. created, and it may not be deleted with the ``\fIpathName \fBtag delete\fR''
  582. widget command.  Furthermore, the \fBselectBackground\fR,
  583. \fBselectBorderWidth\fR, and \fBselectForeground\fR options for
  584. the text widget are tied to the \fB\-background\fR,
  585. \fB\-borderwidth\fR, and \fB\-foreground\fR options for the \fBsel\fR
  586. tag:  changes in either will automatically be reflected in the
  587. other.
  588.  
  589. .SH THE INSERTION CURSOR
  590. .PP
  591. The mark named \fBinsert\fR has special significance in text widgets.
  592. It is defined automatically when a text widget is created and it
  593. may not be unset with the ``\fIpathName \fBmark unset\fR'' widget
  594. command.
  595. The \fBinsert\fR mark represents the position of the insertion
  596. cursor, and the insertion cursor will automatically be drawn at
  597. this point whenever the text widget has the input focus.
  598.  
  599. .SH "WIDGET COMMAND"
  600. .PP
  601. The \fBtext\fR command creates a new Tcl command whose
  602. name is the same as the path name of the text's window.  This
  603. command may be used to invoke various
  604. operations on the widget.  It has the following general form:
  605. .DS C
  606. \fIpathName option \fR?\fIarg arg ...\fR?
  607. .DE
  608. \fIPathName\fR is the name of the command, which is the same as
  609. the text widget's path name.  \fIOption\fR and the \fIarg\fRs
  610. determine the exact behavior of the command.  The following
  611. commands are possible for text widgets:
  612. .TP
  613. \fIpathName \fBcompare\fR \fIindex1 op index2\fR
  614. Compares the indices given by \fIindex1\fR and \fIindex2\fR according
  615. to the relational operator given by \fIop\fR, and returns 1 if
  616. the relationship is satisfied and 0 if it isn't.
  617. \fIOp\fR must be one of the operators <, <=, ==, >=, >, or !=.
  618. If \fIop\fR is == then 1 is returned if the two indices refer to
  619. the same character, if \fIop\fR is < then 1 is returned if \fIindex1\fR
  620. refers to an earlier character in the text than \fIindex2\fR, and
  621. so on.
  622. .TP
  623. \fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
  624. Query or modify the configuration options of the widget.
  625. If no \fIoption\fR is specified, returns a list describing all of
  626. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  627. information on the format of this list).  If \fIoption\fR is specified
  628. with no \fIvalue\fR, then the command returns a list describing the
  629. one named option (this list will be identical to the corresponding
  630. sublist of the value returned if no \fIoption\fR is specified).  If
  631. one or more \fIoption\-value\fR pairs are specified, then the command
  632. modifies the given widget option(s) to have the given value(s);  in
  633. this case the command returns an empty string.
  634. \fIOption\fR may have any of the values accepted by the \fBtext\fR
  635. command.
  636. .TP
  637. \fIpathName \fBdebug \fR?\fIboolean\fR?
  638. If \fIboolean\fR is specified, then it must have one of the true or
  639. false values accepted by Tcl_GetBoolean.
  640. If the value is a true one then internal consistency checks will be
  641. turned on in the B-tree code associated with text widgets.
  642. If \fIboolean\fR has a false value then the debugging checks will
  643. be turned off.
  644. In either case the command returns an empty string.
  645. If \fIboolean\fR is not specified then the command returns \fBon\fR
  646. or \fBoff\fR to indicate whether or not debugging is turned on.
  647. There is a single debugging switch shared by all text widgets:  turning
  648. debugging on or off in any widget turns it on or off for all widgets.
  649. For widgets with large amounts of text, the consistency checks may
  650. cause a noticeable slow-down.
  651. .TP
  652. \fIpathName \fBdelete \fIindex1 \fR?\fIindex2\fR?
  653. Delete a range of characters from the text.
  654. If both \fIindex1\fR and \fIindex2\fR are specified, then delete
  655. all the characters starting with the one given by \fIindex1\fR
  656. and stopping just before \fIindex2\fR (i.e. the character at
  657. \fIindex2\fR is not deleted).
  658. If \fIindex2\fR doesn't specify a position later in the text
  659. than \fIindex1\fR then no characters are deleted.
  660. If \fIindex2\fR isn't specified then the single character at
  661. \fIindex1\fR is deleted.
  662. It is not allowable to delete characters in a way that would leave
  663. the text without a newline as the last character.
  664. The command returns an empty string.
  665. .TP
  666. \fIpathName \fBget \fIindex1 \fR?\fIindex2\fR?
  667. Return a range of characters from the text.
  668. The return value will be all the characters in the text starting
  669. with the one whose index is \fIindex1\fR and ending just before
  670. the one whose index is \fIindex2\fR (the character at \fIindex2\fR
  671. will not be returned).
  672. If \fIindex2\fR is omitted then the single character at \fIindex1\fR
  673. is returned.
  674. If there are no characters in the specified range (e.g. \fIindex1\fR
  675. is past the end of the file or \fIindex2\fR is less than or equal
  676. to \fIindex1\fR) then an empty string is returned.
  677. .TP
  678. \fIpathName \fBindex \fIindex\fR
  679. Returns the position corresponding to \fIindex\fR in the form
  680. \fIline.char\fR where \fIline\fR is the line number and \fIchar\fR
  681. is the character number.
  682. \fIIndex\fR may have any of the forms described under INDICES above.
  683. .TP
  684. \fIpathName \fBinsert \fIindex chars
  685. Inserts \fIchars\fR into the text just before the character at
  686. \fIindex\fR and returns an empty string.
  687. It is not possible to insert characters after the last newline
  688. of the text.
  689. .TP
  690. \fIpathName \fBmark \fIoption \fR?\fIarg arg ...\fR?
  691. This command is used to manipulate marks.  The exact behavior of
  692. the command depends on the \fIoption\fR argument that follows
  693. the \fBmark\fR argument.  The following forms of the command
  694. are currently supported:
  695. .RS
  696. .TP
  697. \fIpathName \fBmark names\fR
  698. Returns a list whose elements are the names of all the marks that
  699. are currently set.
  700. .TP
  701. \fIpathName \fBmark set \fImarkName index\fR
  702. Sets the mark named \fImarkName\fR to a position just before the
  703. character at \fIindex\fR.
  704. If \fImarkName\fR already exists, it is moved from its old position;
  705. if it doesn't exist, a new mark is created.
  706. This command returns an empty string.
  707. .TP
  708. \fIpathName \fBmark unset \fImarkName \fR?\fImarkName markName ...\fR?
  709. Remove the mark corresponding to each of the \fImarkName\fR arguments.
  710. The removed marks will not be usable in indices and will not be
  711. returned by future calls to ``\fIpathName \fBmark names\fR''.
  712. This command returns an empty string.
  713. .RE
  714. .TP
  715. \fIpathName \fBscan\fR \fIoption args\fR
  716. This command is used to implement scanning on texts.  It has
  717. two forms, depending on \fIoption\fR:
  718. .RS
  719. .TP
  720. \fIpathName \fBscan mark \fIy\fR
  721. Records \fIy\fR and the current view in the text window;  used in
  722. conjunction with later \fBscan dragto\fR commands.  Typically this
  723. command is associated with a mouse button press in the widget.  It
  724. returns an empty string.
  725. .TP
  726. \fIpathName \fBscan dragto \fIy\fR
  727. This command computes the difference between its \fIy\fR argument
  728. and the \fIy\fR argument to the last \fBscan mark\fR command for
  729. the widget.  It then adjusts the view up or down by 10 times the
  730. difference in y-coordinates.  This command is typically associated
  731. with mouse motion events in the widget, to produce the effect of
  732. dragging the text at high speed through the window.  The return
  733. value is an empty string.
  734. .RE
  735. .TP
  736. \fIpathName \fBtag \fIoption \fR?\fIarg arg ...\fR?
  737. This command is used to manipulate tags.  The exact behavior of the
  738. command depends on the \fIoption\fR argument that follows the
  739. \fBtag\fR argument.  The following forms of the command are currently
  740. supported:
  741. .RS
  742. .TP
  743. \fIpathName \fBtag add \fItagName index1 \fR?\fIindex2\fR?
  744. Associate the tag \fItagName\fR with all of the characters starting
  745. with \fIindex1\fR and ending just before
  746. \fIindex2\fR (the character at \fIindex2\fR isn't tagged).
  747. If \fIindex2\fR is omitted then the single character at
  748. \fIindex1\fR is tagged.
  749. If there are no characters in the specified range (e.g. \fIindex1\fR
  750. is past the end of the file or \fIindex2\fR is less than or equal
  751. to \fIindex1\fR) then the command has no effect.
  752. This command returns an empty string.
  753. .TP
  754. \fIpathName \fBtag bind \fItagName\fR ?\fIsequence\fR? ?\fIcommand\fR?
  755. This command associates \fIcommand\fR with the tag given by
  756. \fItagName\fR.
  757. Whenever the event sequence given by \fIsequence\fR occurs for a
  758. character that has been tagged with \fItagName\fR,
  759. the command will be invoked.
  760. This widget command is similar to the \fBbind\fR command except that
  761. it operates on characters in a text rather than entire widgets.
  762. See the \fBbind\fR manual entry for complete details
  763. on the syntax of \fIsequence\fR and the substitutions performed
  764. on \fIcommand\fR before invoking it.
  765. If all arguments are specified then a new binding is created, replacing
  766. any existing binding for the same \fIsequence\fR and \fItagName\fR
  767. (if the first character of \fIcommand\fR is ``+'' then \fIcommand\fR
  768. augments an existing binding rather than replacing it).
  769. In this case the return value is an empty string.
  770. If \fIcommand\fR is omitted then the command returns the \fIcommand\fR
  771. associated with \fItagName\fR and \fIsequence\fR (an error occurs
  772. if there is no such binding).
  773. If both \fIcommand\fR and \fIsequence\fR are omitted then the command
  774. returns a list of all the sequences for which bindings have been
  775. defined for \fItagName\fR.
  776. .RS
  777. .LP
  778. The only events for which bindings may be specified are those related
  779. to the mouse and keyboard, such as \fBEnter\fR, \fBLeave\fR,
  780. \fBButtonPress\fR, \fBMotion\fR, and \fBKeyPress\fR.
  781. Event bindings for a text widget use the \fBcurrent\fR mark
  782. described under MARKS above.
  783. \fBEnter\fR events trigger for a character when it
  784. becomes the current character (i.e. the \fBcurrent\fR mark moves
  785. to just in front of that character).
  786. \fBLeave\fR events trigger for a character when it ceases to be
  787. the current item (i.e. the \fBcurrent\fR mark moves away from
  788. that character, or the character is deleted).
  789. These events are different than \fBEnter\fR and \fBLeave\fR
  790. events for windows.
  791. Mouse and keyboard events are directed to the current character.
  792. .LP
  793. It is possible for the current character to have multiple tags,
  794. and for each of them to have a binding for a particular event
  795. sequence.
  796. When this occurs, the binding from the highest priority tag is
  797. used.
  798. If a particular tag doesn't have a binding that matches an
  799. event, then the tag is ignored and tags with lower priority
  800. will be checked.
  801. .LP
  802. If bindings are created for the widget as a whole using the
  803. \fBbind\fR command, then those bindings will supplement the
  804. tag bindings.
  805. This means that a single event can trigger two Tcl scripts,
  806. one for a widget-level binding and one for a tag-level
  807. binding.
  808. .RE
  809. .TP
  810. \fIpathName \fBtag configure \fItagName\fR ?\fIoption\fR? ?\fIvalue\fR? ?\fIoption value ...\fR?
  811. This command is similar to the \fBconfigure\fR widget command except
  812. that it modifies options associated with the tag given by \fItagName\fR
  813. instead of modifying options for the overall text widget.
  814. If no \fIoption\fR is specified, the command returns a list describing
  815. all of the available options for \fItagName\fR (see \fBTk_ConfigureInfo\fR
  816. for information on the format of this list).
  817. If \fIoption\fR is specified with no \fIvalue\fR, then the command returns
  818. a list describing the one named option (this list will be identical to
  819. the corresponding sublist of the value returned if no \fIoption\fR
  820. is specified).
  821. If one or more \fIoption\-value\fR pairs are specified, then the command
  822. modifies the given option(s) to have the given value(s) in \fItagName\fR;
  823. in this case the command returns an empty string.
  824. See TAGS above for details on the options available for tags.
  825. .TP
  826. \fIpathName \fBtag delete \fItagName \fR?\fItagName ...\fR?
  827. Deletes all tag information for each of the \fItagName\fR
  828. arguments.
  829. The command removes the tags from all characters in the file
  830. and also deletes any other information associated with the tags,
  831. such as bindings and display information.
  832. The command returns an empty string.
  833. .TP
  834. \fIpathName\fBtag lower \fItagName \fR?\fIbelowThis\fR?
  835. Changes the priority of tag \fItagName\fR so that it is just lower
  836. in priority than the tag whose name is \fIbelowThis\fR.
  837. If \fIbelowThis\fR is omitted, then \fItagName\fR's priority
  838. is changed to make it lowest priority of all tags.
  839. .TP
  840. \fIpathName \fBtag names \fR?\fIindex\fR?
  841. Returns a list whose elements are the names of all the tags that
  842. are active at the character position given by \fIindex\fR.
  843. If \fIindex\fR is omitted, then the return value will describe
  844. all of the tags that exist for the text (this includes all tags
  845. that have been named in a ``\fIpathName \fBtag\fR'' widget
  846. command but haven't been deleted by a ``\fIpathName \fBtag delete\fR''
  847. widget command, even if no characters are currently marked with
  848. the tag).
  849. The list will be sorted in order from lowest priority to highest
  850. priority.
  851. .TP
  852. \fIpathName \fBtag nextrange \fItagName index1 \fR?\fIindex2\fR?
  853. This command searches the text for a range of characters tagged
  854. with \fItagName\fR where the first character of the range is
  855. no earlier than the character at \fIindex1\fR and no later than
  856. the character just before \fIindex2\fR (a range starting at
  857. \fIindex2\fR will not be considered).
  858. If several matching ranges exist, the first one is chosen.
  859. The command's return value is a list containing
  860. two elements, which are the index of the first character of the
  861. range and the index of the character just after the last one in
  862. the range.
  863. If no matching range is found then the return value is an
  864. empty string.
  865. If \fIindex2\fR is not given then it defaults to the end of the text.
  866. .TP
  867. \fIpathName\fBtag raise \fItagName \fR?\fIaboveThis\fR?
  868. Changes the priority of tag \fItagName\fR so that it is just higher
  869. in priority than the tag whose name is \fIaboveThis\fR.
  870. If \fIaboveThis\fR is omitted, then \fItagName\fR's priority
  871. is changed to make it highest priority of all tags.
  872. .TP
  873. \fIpathName \fBtag ranges \fItagName\fR
  874. Returns a list describing all of the ranges of text that have been
  875. tagged with \fItagName\fR.
  876. The first two elements of the list describe the first tagged range
  877. in the text, the next two elements describe the second range, and
  878. so on.
  879. The first element of each pair contains the index of the first
  880. character of the range, and the second element of the pair contains
  881. the index of the character just after the last one in the
  882. range.
  883. If there are no characters tagged with \fItag\fR then an
  884. empty string is returned.
  885. .TP
  886. \fIpathName \fBtag remove \fItagName index1 \fR?\fIindex2\fR?
  887. Remove the tag \fItagName\fR from all of the characters starting
  888. at \fIindex1\fR and ending just before
  889. \fIindex2\fR (the character at \fIindex2\fR isn't affected).
  890. If \fIindex2\fR is omitted then the single character at
  891. \fIindex1\fR is untagged.
  892. If there are no characters in the specified range (e.g. \fIindex1\fR
  893. is past the end of the file or \fIindex2\fR is less than or equal
  894. to \fIindex1\fR) then the command has no effect.
  895. This command returns an empty string.
  896. .RE
  897. .TP
  898. \fIpathName \fByview \fR?\fB\-pickplace\fR? \fIwhat\fR
  899. This command changes the view in the widget's window so that the line
  900. given by \fIwhat\fR is visible in the window.
  901. \fIWhat\fR may be either an absolute line number, where 0 corresponds
  902. to the first line of the file, or an index with any of the forms
  903. described under INDICES above.
  904. The first form (absolute line number) is used in the commands issued
  905. by scrollbars to control the widget's view.
  906. If the \fB\-pickplace\fR option isn't specified then \fIwhat\fR will
  907. appear at the top of the window.
  908. If \fB\-pickplace\fR is specified then the widget chooses where
  909. \fIwhat\fR appears in the window:
  910. .RS
  911. .IP [1]
  912. If \fIwhat\fR is already visible somewhere in the window then the
  913. command does nothing.
  914. .IP [2]
  915. If \fIwhat\fR is only a few lines off-screen above the window then
  916. it will be positioned at the top of the window.
  917. .IP [3]
  918. If \fIwhat\fR is only a few lines off-screen below the window then
  919. it will be positioned at the bottom of the window.
  920. .IP [4]
  921. Otherwise, \fIwhat\fR will be centered in the window.
  922. .LP
  923. The \fB\-pickplace\fR option is typically used after inserting text
  924. to make sure that the insertion cursor is still visible on the screen.
  925. This command returns an empty string.
  926. .RE
  927.  
  928. .SH BINDINGS
  929. .PP
  930. Tk automatically creates class bindings for texts that give them
  931. the following default behavior:
  932. .IP [1]
  933. Pressing mouse button 1 in an text positions the insertion cursor
  934. just before the character underneath the mouse cursor and sets the
  935. input focus to this widget.
  936. .IP [2]
  937. Dragging with mouse button 1 strokes out a selection between
  938. the insertion cursor and the character under the mouse.
  939. .IP [3]
  940. If you double-press mouse button 1 then the word under the mouse cursor
  941. will be selected, the insertion cursor will be positioned at the
  942. beginning of the word, and dragging the mouse will stroke out a selection
  943. whole words at a time.
  944. .IP [4]
  945. If you triple-press mouse button 1 then the line under the mouse cursor
  946. will be selected, the insertion cursor will be positioned at the
  947. beginning of the line, and dragging the mouse will stroke out a selection
  948. whole line at a time.
  949. .IP [5]
  950. The ends of the selection can be adjusted by dragging with mouse
  951. button 1 while the shift key is down;  this will adjust the end
  952. of the selection that was nearest to the mouse cursor when button
  953. 1 was pressed.  If the selection was made in word or line mode then
  954. it will be adjusted in this same mode.
  955. .IP [6]
  956. The view in the text can be adjusted by dragging with mouse button 2.
  957. .IP [7]
  958. If the input focus is in a text widget and characters are typed on the
  959. keyboard, the characters are inserted just before the insertion cursor.
  960. .IP [8]
  961. Control+h and the Backspace and Delete keys erase the character just
  962. before the insertion cursor.
  963. .IP [9]
  964. Control+v inserts the current selection just before the insertion cursor.
  965. .IP [10]
  966. Control+d deletes the selected characters;  an error occurs if the selection
  967. is not in this widget.
  968. .PP
  969. If the text is disabled using the \fBstate\fR option, then the text's
  970. view can still be adjusted and text in the text can still be selected,
  971. but no insertion cursor will be displayed and no text modifications will
  972. take place.
  973. .PP
  974. The behavior of texts can be changed by defining new bindings for
  975. individual widgets or by redefining the class bindings.
  976.  
  977. .SH "PERFORMANCE ISSUES"
  978. .PP
  979. Text widgets should run efficiently under a variety
  980. of conditions.  The text widget uses about 2-3 bytes of
  981. main memory for each byte of text, so texts containing a megabyte
  982. or more should be practical on most workstations.
  983. Text is represented internally with a modified B-tree structure
  984. that makes operations relatively efficient even with large texts.
  985. Tags are included in the B-tree structure in a way that allows
  986. tags to span large ranges or have many disjoint smaller ranges
  987. without loss of efficiency.
  988. Marks are also implemented in a way that allows large numbers of
  989. marks.
  990. The only known mode of operation where a text widget may not run
  991. efficiently is if it has a very large number of different tags.
  992. Hundreds of tags should be fine, or even a thousand,
  993. but tens of thousands of tags will make texts consume a lot of
  994. memory and run slowly.
  995.  
  996. .SH KEYWORDS
  997. text, widget
  998.